1.注释版的 Django 日志配置
# settings.py
BASE_LOG_DIR = os.path.join(BASE_DIR, "log") # 日志文件夹
LOGGING = {
'version': 1, # 保留字
'disable_existing_loggers': False, # 是否禁用已经存在的logger实例
# 日志的格式 -> 可以在这里定制自己需要的日志格式
'formatters': {
# 详细的日志格式
'standard': {
'format': '[%(asctime)s][%(threadName)s:%(thread)d][task_id:%(name)s][%(filename)s:%(lineno)d]'
'[%(levelname)s][%(message)s]'
},
# 简单的日志格式
'simple': {
'format': '[%(levelname)s][%(asctime)s][%(filename)s:%(lineno)d]%(message)s'
},
# 定义一个特殊的日志格式
'collect': {
'format': '%(message)s'
}
},
# 过滤器
'filters': {
'require_debug_true': { # 当 DEBUG 配置项等于 True 的时候执行
'()': 'django.utils.log.RequireDebugTrue', # '()' 代表全部
},
},
# 处理器
'handlers': {
# 在终端打印
'console': {
'level': 'DEBUG', # 设置日志级别 -> 该处理器只输出 DEBUG 级别以上的日志
'filters': ['require_debug_true'], # 只有在Django debug为True时才在终端打印日志
'class': 'logging.StreamHandler',
'formatter': 'simple' # 使用formatters所定义的日志格式
},
'SF': {
'level': 'INFO', # 设置日志级别 -> 该处理器只保存 INFO 级别以上的日志
'class': 'logging.handlers.RotatingFileHandler', # 保存到文件，根据文件大小自动切
'filename': os.path.join(BASE_LOG_DIR, "xxx_info.log"), # 日志文件
'maxBytes': 1024 * 1024 * 50, # 日志大小 50M
'backupCount': 3, # 备份数为3 xx.log --> xx.log.1 --> xx.log.2 --> xx.log.3
'formatter': 'standard', # 使用formatters所定义的日志格式
'encoding': 'utf-8', # 日志文件的编码
},
'TF': {
'level': 'INFO', # 设置日志级别 -> 该处理器只保存 INFO 级别以上的日志
'class': 'logging.handlers.TimedRotatingFileHandler', # 保存到文件，根据时间自动切
'filename': os.path.join(BASE_LOG_DIR, "xxx_info.log"), # 日志文件
'backupCount': 3, # 备份数为3 xx.log --> xx.log.2018-08-23_00-00-00 --> xx.log.2018-08-24_00-00-00 --> ...
'when': 'D', # 每天一切， 可选值有S/秒 M/分 H/小时 D/天 W0-W6/周(0=周一) midnight/如果没指定时间就默认在午夜
'formatter': 'standard', # 使用formatters所定义的日志格式
'encoding': 'utf-8', # 日志文件的编码
},
'error': {
'level': 'ERROR', # 设置日志级别 -> 该处理器只保存 ERROR 级别以上的日志
'class': 'logging.handlers.RotatingFileHandler', # 保存到文件，根据文件大小自动切
'filename': os.path.join(BASE_LOG_DIR, "xxx_err.log"), # 日志文件
'maxBytes': 1024 * 1024 * 5, # 日志大小 50M
'backupCount': 5, # 备份数为3 xx.log --> xx.log.1 --> xx.log.2 --> xx.log.3
'formatter': 'standard', # 使用formatters所定义的日志格式
'encoding': 'utf-8', # 日志文件的编码
},
# 一般记录一些特殊的数据
'collect': {
'level': 'INFO', # 设置日志级别 -> 该处理器只保存 INFO 级别以上的日志
'class': 'logging.handlers.RotatingFileHandler', # 保存到文件，根据文件大小自动切
'filename': os.path.join(BASE_LOG_DIR, "xxx_collect.log"), # 日志文件
'maxBytes': 1024 * 1024 * 50, # 日志大小 50M
'backupCount': 5, # 备份数为3 xx.log --> xx.log.1 --> xx.log.2 --> xx.log.3
'formatter': 'collect', # 使用formatters所定义的日志格式
'encoding': "utf-8" # 日志文件的编码
}
},
# 总的日志配置项，指定django中的每个模块使用哪个handlers，以及日志输出的级别
'loggers': {
# 默认的logger应用如下配置 -> 通俗理解: 默认项目所生成的 logger 都走下面的配置
'': {
'handlers': ['SF', 'console', 'error'], # 使用 'SF', 'console', 'error' 处理器，上线之后可以把'console'移除
'level': 'DEBUG', # 设置总的日志级别
'propagate': True, # 向不向更高级别的logger传递
},
# 对名为 'collect' 的 logger实例进行单独配置
'collect': {
'handlers': ['console', 'collect'], # 使用 'console', 'collect' 处理器，上线之后可以把'console'移除
'level': 'INFO', # 设置总的日志级别
}
},
}
2. 无注释版的 Django 日志配置
BASE_LOG_DIR = os.path.join(BASE_DIR, "log")
LOGGING = {
'version': 1,
'disable_existing_loggers': False,
'formatters': {
'standard': {
'format': '[%(asctime)s][%(threadName)s:%(thread)d][task_id:%(name)s][%(filename)s:%(lineno)d]'
'[%(levelname)s][%(message)s]'
},
'simple': {
'format': '[%(levelname)s][%(asctime)s][%(filename)s:%(lineno)d]%(message)s'
},
'collect': {
'format': '%(message)s'
}
},
'filters': {
'require_debug_true': {
'()': 'django.utils.log.RequireDebugTrue',
},
},
'handlers': {
'console': {
'level': 'DEBUG',
'filters': ['require_debug_true'],
'class': 'logging.StreamHandler',
'formatter': 'simple'
},
'SF': {
'level': 'INFO',
'class': 'logging.handlers.RotatingFileHandler',
'filename': os.path.join(BASE_LOG_DIR, "xxx_info.log"),
'maxBytes': 1024 * 1024 * 50,
'backupCount': 3,
'formatter': 'standard',
'encoding': 'utf-8',
},
'TF': {
'level': 'INFO',
'class': 'logging.handlers.TimedRotatingFileHandler',
'filename': os.path.join(BASE_LOG_DIR, "xxx_info.log"),
'backupCount': 3,
'when': 'D',
'formatter': 'standard',
'encoding': 'utf-8',
},
'error': {
'level': 'ERROR',
'class': 'logging.handlers.RotatingFileHandler',
'filename': os.path.join(BASE_LOG_DIR, "xxx_err.log"),
'maxBytes': 1024 * 1024 * 5,
'backupCount': 5,
'formatter': 'standard',
'encoding': 'utf-8',
},
'collect': {
'level': 'INFO',
'class': 'logging.handlers.RotatingFileHandler',
'filename': os.path.join(BASE_LOG_DIR, "xxx_collect.log"),
'maxBytes': 1024 * 1024 * 50,
'backupCount': 5,
'formatter': 'collect',
'encoding': "utf-8"
}
},
'loggers': {
'': {
'handlers': ['SF', 'console', 'error'],
'level': 'DEBUG',
'propagate': True,
},
'collect': {
'handlers': ['console', 'collect'],
'level': 'INFO',
}
},
}
3.使用日志
# views.py
from django.shortcuts import render, HttpResponse
import logging
logger = logging.getLogger(__name__) # 生成一个以当前文件名为名字的logger实例
collect_logger = logging.getLogger("collect") # 生成一个名为collect的logger实例
def index(request):
logging.debug('调试信息')
logging.info('正常信息')
logging.warning('警告信息')
logging.error('错误信息')
logging.critical('严重错误信息')
collect_logger.info('name: Kevin')
collect_logger.info('age: 18')
return HttpResponse('index')
4.当项目被运行的时候就会生成对应的日志文件或在终端打印对应的日志
- 因为我在日志配置项中的 loggers 调用了指定的处理器所以会在 log 目录下生成对应的日志文件，保存对应的日志
# xxx_info.log
[2019-05-13 18:12:35,196][Thread-1:17964][task_id:root][views.py:10][INFO][正常信息]
[2019-05-13 18:12:35,196][Thread-1:17964][task_id:root][views.py:11][WARNING][警告信息]
[2019-05-13 18:12:35,196][Thread-1:17964][task_id:root][views.py:12][ERROR][错误信息]
[2019-05-13 18:12:35,196][Thread-1:17964][task_id:root][views.py:13][CRITICAL][严重错误信息]
[2019-05-13 18:12:35,196][Thread-1:17964][task_id:collect][views.py:15][INFO][name: Kevin]
[2019-05-13 18:12:35,197][Thread-1:17964][task_id:collect][views.py:16][INFO][age: 18]
# xxx_error.log
[2019-05-13 18:12:35,196][Thread-1:17964][task_id:root][views.py:12][ERROR][错误信息]
[2019-05-13 18:12:35,196][Thread-1:17964][task_id:root][views.py:13][CRITICAL][严重错误信息]
# xxx_collect.log -> 保存特殊的数据
name: Kevin
age: 18